CheckinDocument
|
CheckinDocument
|
|||
|
Main
|
History-Relevant
|
||
|
Rückgabewert
|
|||
|
RET
|
|||
|
Parameterliste
|
|||
|
DocumentId
|
IN
|
LONG_NUMERIC_IDENTIFIER
|
>DOCUMENT.DOCUMENTID
|
|
EnforceCreateVersion
|
IN
|
Boolean
|
|
|
RemainCreatorPass
|
IN
|
Boolean (Default false)
|
>DOCUMENT.CREATORPASS
|
|
VersionComment
|
IN
|
EXTRALONG_STRING (Default „“)
|
>VERSION.COMMENT
|
|
RecalcConversionBase
|
IN
|
Boolean (Default false)
|
|
Kurzbeschreibung:
Dieser Service macht ein Checkin auf einem Dokument. Das heisst, dass
die Markierung auf dem Dokument entfernt wird. Je nach Versionierungsmodus
wird mit der temp. Version unterschiedlich verfahren wobei die Boolean
EnforceCreateVersion NUR im Fall VersioningMode gleich MANUAL einen
Einfluss hat:
OFF: Die temporäre Version ersetzt die CurrentVersion; diese wird als
gelöscht markiert.
MANUAL: Ist die CurrentVersion RELEASED wird automatisch eine neue
Version erstellt.
Ist die CurrentVersion AVAILABLE so wird nur eine neue Version
erstellt, wenn dies über die Boolean EnforceCreateVersion explizit
verlangt wird.
AUTOMATIC: Die temporäre Version wird als neue Version etabliert und
AVAILABLE gesetzt.
 |
NotizDas Attribut CreatorPass wird im
Normalfall auf 0 zurückgesetzt. Dies kann aber mit Hilfe des Parameters
„RemainCreatorPass“ und dem Wert 1 bzw. true verhindert werden. Wird ein
VersionComment ungleich Leerstring mitgegeben, so wird dieser Kommentar
auf der einzucheckenden Version gesetzt!
Mit Hilfe des Parameters
RecalcConversionBase kann in Mediendokumente erreicht werden, dass die
bestehende Konvertierungsbasis (die im Normalfall bestehen bleibt)
überprüft wird und sofern eine relevantere Konvertierungsbasis existiert
neu ab dieser konvertiert wird, auch wenn gar keine Datei direkt geändert
wurde!
Das interne Attribut CheckinOOMandantNo wird zum Zwecke einer
späteren Signierung mit dem aktuellen OpaccERP-Mandanten aus dem
Service-Kontext gefüllt!
|
Fehlerhandling/Plausibilisierung:
Generell gelten die Regeln (PK, AK, FK, Unique, NotNull) der Datenbank.
Die zusätzlichen Fehler sind:
-
Aufgrund von Validator-Prüfungen (VD)
-
Wenn das Dokument über die DocumentId nicht gefunden wird (1/2)
-
Wenn auf der verknüpften Sicherheitszone die Modify-Rechte fehlen (3/6)
-
Wenn die Checkout-Version über die VersionId nicht gefunden wird (4)
-
Wenn ein File über die FileId nicht gefunden wird (5)
-
Wenn der FileAccess nicht registriert ist (7)
-
Der StorageDirectorAndProtector im FileAccess nicht registriert ist (8)
-
Wenn das Lesen der Datei aufgrund des geschlossenen StorageDirectors blockiert wurde (9)
-
Die Datei kleiner als der gewünschte Offset ist (10)
-
Wenn das Schreiben der Datei aufgrund des geschlossenen StorageDirectors blockiert wurde (11)
-
Wenn das Schreiben der Datei aufgrund des „ReadOnly“ StorageDirectors blockiert wurde (12)
-
Die empfangene Datei auf dem Medium grösser ist als sie deklariert wurde (13)
-
Wenn nach dem internen Umkopieren einer referenzierten Datei die Grössenüberprüfung fehlschlägt (14)
-
Wenn das Document nicht ausgecheckt ist (15)
-
Wenn das Document von einem anderen User ausgecheckt wurde (16)
-
Wenn keine Checkout-Version am Document hängt (17)
-
Wenn eine Datei (noch) nicht bereit ist für den Checkin-Vorgang (18)
-
Wenn nicht alle neuen Dateien zum DMS hin übertragen wurden (19)
-
Wenn das WorkingStorage nicht zugewiesen werden kann (20)
-
Wenn die Version bei der Storage-Zuweisung nicht zugegriffen werden kann (21)
-
Wenn versucht wird eine Version zu überschreiben, welche nicht die Neueste ist (22)
-
Wenn das Document den VersioningMode OFF besitzt und die zu überschreibende Version RELEASED ist (23)
-
Wenn das Document den VersioningMode MANUAL besitzt und die zu überschreibende Version RELEASED oder RETIRED ist (24)
-
Wenn das Dokument mit gesetztem Medienbasistyp zwar eine Datei mit Mediensubtyp AUTOMATIC hat, nicht aber eine Datei eines Mediensubtyps besitzt welche als Konvertierungsbasis dienen kann (25)
-
Wenn der auf dem Dokument gesetzte Medienbasistyp über ,ONREQUEST‘-Mediensubtypen verfügt, auf dem Dokument aber keine Datei eines Mediensubtyps existiert welche als Konvertierungsbasis dienen kann (26)
Bemerkungen:
(1): GetDocNEx
(2): CheckinDocNEx
(3):
CheckinDocInsuffPriv
(4): GetVrsNEx
(5): ModFileNEx
(6):
ModFileInsuffPriv
(7): EnvFileAccNReg
(8):
EnvStrgDirAndProtNReg
(9):
EnvStrgDirAndProtReadBlkClosedStrg
(10):
EnvFileAccOfstFileSizeExd
(11):
EnvStrgDirAndProtWriteBlkClosedStrg
(12):
EnvStrgDirAndProtWriteBlkReadOnlyStrg
(13):
EnvStrgDirAndProtFileSizeExd
(14):
EnvFileAccFileCopyFinalSizeCheckFailed
(15):
CheckinDocNCheckedOut
(16):
CheckinDocCheckoutUsrMsm
(17):
CheckinDocCheckoutVrsMs
(18):
CheckinDocFileNRy
(19):
CheckinDocFilesNComp
(20):
ModVrsNoStrg
(21): ModVrsNEx (22): CheckinDocOwrtBlkNHighVrs
(23):
CheckinDocOwrtBlkRsdVrsInVrsModeOff
(24):
CheckinDocOwrtBlkRsdOrRetVrsInVrsModeMan
(25):
CheckinDocFileConvBaseNEx
(26):
CheckinDocConvBaseNEx